Loading TOC...

MarkLogic Server 11.0 Product Documentation
GET /manage/v2/forests/{id|name}

Summary

Retrieve information about a forest. The forest can be identified either by id or name.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This parameter is not meaningful with view=edit. This value overrides the Accept header if both are present.
view A specific view of the returned data. Can be either default, counts, edit, or status. Default: default.
property This parameter returns a specific count value when using view=counts. The value can be any first-level child element of the count-properties element. You can include multiple property parameters in this resource address.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

For all views except edit, upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If view=edit, MarkLogic Server responds with status code 302 (Found) and the Location header contains a redirect to the appropriate page in the Admin Interface.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The counts view includes the stand count, document count, directory count, reindex refragment fragment count, reindex fragment count, and refragment document count.

The structure of the data in the response for the default view is as follows:

id

A forest unique ID (64-bit value).

name

The forest name.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example


http://localhost:8002/manage/v2/forests/Documents

==> Returns the default information on the Documents forest.

Example


http://localhost:8002/manage/v2/forests/Documents?format=json

==> Returns information about the Documents forest, as JSON.

Example


http://localhost:8002/manage/v2/forests/Documents?view=counts

==> Returns counts view information of Documents forest

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.